Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: Add --file [files...] command line option to lint command. #5328

Merged
merged 1 commit into from
Mar 1, 2024
Merged

feat: Add --file [files...] command line option to lint command. #5328

merged 1 commit into from
Mar 1, 2024

Conversation

Jason3S
Copy link
Collaborator

@Jason3S Jason3S commented Mar 1, 2024 •
edited
Loading

fixes: #5225

Options:

  • --file and --files - specify files to be checked

--file [files...], alias --files.

The --file option enables specifying which files to check. This is useful when the list is generated by another process and --file-list is not a good fit.

The files will be filtered by [globs...] or cspellConfig.files if the [globs...] were not specified.

Usage:

cspell.config.yaml

files:
  - '**/*.md'
ignorePaths:
  - 'CHANGELOG.md'

Command:

cspell --files README.md CHANGELOG.md LICENSE

Result:
It will only check README.md because LICENSE does not match *.md and CHANGELOG.md is excluded by ignorePaths.

Command Line Only
The same effect can be achieved on the command line:

cspell "*.md" --exclude CHANGELOG.md --files README.md CHANGELOG.md LICENSE
- or -
cspell --exclude CHANGELOG.md --files README.md CHANGELOG.md LICENSE -- "*.md"

@Jason3S
feat: Add command-line options
f759f28 
Options:
- `--file` and `--files` - specify files to be checked
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 1, 2024 •
edited
Loading

Performance Report

Repository Elapsed Min/Avg/Max SD SD Graph
AdaDoom3/AdaDoom3 12.29 11.7 / 12.0 / 12.5 0.19 ┣━━┻━━╋━━┻●━┫
alexiosc/megistos 30.21 29.5 / 30.9 / 32.8 0.80 ┣━━●━━╋━━┻━━┫
apollographql/apollo-server 6.51 6.3 / 6.6 / 6.9 0.19 ┣━┻●━╋━━┻━┫
aspnetboilerplate/aspnetboilerplate 25.41 22.7 / 23.3 / 24.3 0.41 ┣━┻━╋━┻━┫ ●
aws-amplify/docs 30.58 30.6 / 31.8 / 33.6 0.89 ┣━●┻━━╋━━┻━━┫
Azure/azure-rest-api-specs 30.10 27.6 / 28.7 / 30.8 0.79 ┣━━┻━━╋━━┻━●┫
bitjson/typescript-starter 0.77 0.7 / 0.8 / 1.0 0.06 ┣━━┻━●━┻━━┫
caddyserver/caddy 9.96 9.8 / 10.3 / 10.9 0.24 ┣━●┻━━╋━━┻━━┫
canada-ca/open-source-logiciel-libre 0.91 0.9 / 0.9 / 1.0 0.03 ┣━━┻━●━┻━━┫
chef/chef 20.43 19.8 / 20.8 / 21.8 0.58 ┣━━┻●━╋━━┻━━┫
django/django 50.52 49.6 / 51.4 / 53.2 0.91 ┣━━●━━╋━━┻━━┫
eslint/eslint 29.86 29.8 / 31.6 / 37.1 1.34 ┣━●┻━━╋━━┻━━┫
exonum/exonum 11.62 11.1 / 11.6 / 12.2 0.29 ┣━━┻━━●━━┻━━┫
gitbucket/gitbucket 7.02 6.6 / 6.9 / 7.3 0.21 ┣━┻━━╋●━┻━┫
googleapis/google-cloud-cpp 373.28 349.8 / 367.2 / 395.7 11.01 ┣━━━┻━━━╋━●━┻━━━┫
graphql/express-graphql 0.79 0.8 / 0.8 / 1.0 0.04 ┣━━●━╋━┻━━┫
graphql/graphql-js 5.90 5.6 / 6.0 / 6.6 0.22 ┣━┻━●╋━━┻━┫
graphql/graphql-relay-js 0.76 0.8 / 0.8 / 0.9 0.04 ┣━●┻━╋━┻━━┫
graphql/graphql-spec 1.83 1.8 / 1.8 / 2.0 0.06 ┣━━┻●╋━┻━━┫
iluwatar/java-design-patterns 29.31 28.1 / 29.5 / 31.2 0.93 ┣━━┻━●╋━━┻━━┫
ktaranov/sqlserver-kit 22.80 22.7 / 23.4 / 24.4 0.41 ┣━●┻━━╋━━┻━━┫
liriliri/licia 7.83 7.3 / 8.1 / 9.7 0.44 ┣━━┻●━╋━━┻━━┫
MartinThoma/LaTeX-examples 13.30 13.1 / 13.6 / 13.9 0.21 ┣━●┻━━╋━━┻━━┫
mdx-js/mdx 3.73 3.6 / 3.8 / 4.0 0.09 ┣━┻━●╋━━┻━┫
microsoft/TypeScript-Website 17.21 16.9 / 17.6 / 19.0 0.56 ┣━━┻●━╋━━┻━━┫
MicrosoftDocs/PowerShell-Docs 110.97 99.3 / 105.4 / 112.9 3.12 ┣━━┻━━━╋━━━┻━●┫
neovim/nvim-lspconfig 8.98 8.1 / 8.4 / 8.8 0.21 ┣━━┻━━╋━━┻━━┫ ●
pagekit/pagekit 7.26 6.9 / 7.4 / 7.9 0.21 ┣━━┻●━╋━━┻━━┫
php/php-src 118.77 106.2 / 111.0 / 119.6 3.12 ┣━━┻━━━╋━━━┻━━┫ ●
plasticrake/tplink-smarthome-api 1.47 1.4 / 1.5 / 1.6 0.05 ┣━━┻━●━┻━━┫
prettier/prettier 13.13 12.7 / 13.1 / 13.8 0.28 ┣━━┻━━╋●━┻━━┫
pycontribs/jira 2.41 2.3 / 2.4 / 2.6 0.06 ┣━━┻●╋━┻━━┫
RustPython/RustPython 13.71 12.7 / 13.3 / 13.9 0.31 ┣━━┻━━╋━━┻●━┫
shoelace-style/shoelace 7.01 7.0 / 7.3 / 8.2 0.24 ┣━━●━━╋━━┻━━┫
SoftwareBrothers/admin-bro 3.80 3.8 / 4.0 / 4.4 0.17 ┣━●━━╋━━┻━┫
sveltejs/svelte 34.50 33.8 / 34.9 / 36.9 0.79 ┣━━┻●━╋━━┻━━┫
TheAlgorithms/Python 16.52 15.9 / 16.5 / 17.7 0.38 ┣━━┻━━●━━┻━━┫
twbs/bootstrap 3.68 3.6 / 3.7 / 4.0 0.11 ┣━┻━━●━━┻━┫
typescript-cheatsheets/react 2.06 2.0 / 2.1 / 2.2 0.06 ┣━━┻━●━┻━━┫
typescript-eslint/typescript-eslint 7.54 7.3 / 7.8 / 8.4 0.25 ┣━━●━━╋━━┻━━┫
w3c/aria-practices 9.12 9.3 / 9.6 / 10.2 0.26 ┣●━┻━━╋━━┻━━┫
w3c/specberus 2.75 2.7 / 2.8 / 3.0 0.07 ┣━●━━╋━━┻━┫
webdeveric/webpack-assets-manifest 0.70 0.7 / 0.7 / 0.8 0.04 ┣━━●━╋━┻━━┫
webpack/webpack 11.97 11.3 / 12.0 / 12.4 0.28 ┣━━┻━━●━━┻━━┫
wireapp/wire-desktop 1.26 1.2 / 1.2 / 1.4 0.05 ┣━━┻━╋━●━━┫
wireapp/wire-webapp 20.46 20.0 / 21.1 / 25.2 1.08 ┣━━┻●━╋━━┻━━┫
Repository Elapsed Rel Trend Count
AdaDoom3/AdaDoom3 12.29 2.48% ▃▂▁█▄▂▂▆▅▃▃▅▇▅▄▄▄▃▂▆ 24
alexiosc/megistos 30.21 -2.21% ▄▃▄▄▂▃▃▅▁▆▄▄▄▅▇▂▂▂▃▂ 24
apollographql/apollo-server 6.51 -1.90% ▆▃▅▅▆▅▂▂▄▅▆▂▃▃▂▄▁▂▁▃ 25
aspnetboilerplate/aspnetboilerplate 25.41 9.07% ▃▃▅▅▄▃▇▆█▄▅▄▄▃▄▄▄▃▂█ 24
aws-amplify/docs 30.58 -3.79% ▂▅▇▃▅▆▄▃▂▂▄▄▃▄▂▂▅▂▄▂ 24
Azure/azure-rest-api-specs 30.10 4.86% ▂▇▃▃▃▃▄▂▃▅▂▄▂▃▄▄▂▃▆▇ 24
bitjson/typescript-starter 0.77 -0.35% ▃▃▃▃▇▅▃▃▃▃▂▃▃▃█▃█▃▃▄ 24
caddyserver/caddy 9.96 -3.00% ▃▃▂▄▅▇▄▅▅▄▃▃▃▃▄▃▂█▁▂ 24
canada-ca/open-source-logiciel-libre 0.91 0.38% ▃▂▃▃▆█▃▅▃▃▃▃▄▃▃▃▆▄▃▄ 24
chef/chef 20.43 -1.65% ▃▄▃▃▅▆▃▄▁▄▃▃▁▆▁▄▄▆▆▃ 24
django/django 50.52 -1.68% ▅▃▄▂▂▃▃▅▂▄▂▅▃▁▅▅▄▃▂ 24
eslint/eslint 29.86 -5.41% ▃▃▂▄▄▅▃▃▃▂▄▅▂▃▅▄▃▄▄▂ 24
exonum/exonum 11.62 0.03% ▄▂▄▃▇▆▅▆▅▄▁▂▆▂▄▃▂▃▁▄ 24
gitbucket/gitbucket 7.02 1.42% ▅▅▃▂▄▄▁▃▃▃▇▆▅▃▃▅▅▁▃▄ 24
googleapis/google-cloud-cpp 373.28 1.65% ▃▃▃▃▅▃▁▃▁▂▂▃▆▃▄▃▄▆▆▅ 25
graphql/express-graphql 0.79 -3.57% ▃▄▅▃▇█▃▃▂▂▃▃▃▃▃▃▃▃▃▃ 25
graphql/graphql-js 5.90 -1.36% ▃▄▂▄█▅▆▅▅▄▃▄▄▄▁▆▅▂▁▃ 25
graphql/graphql-relay-js 0.76 -6.46% ▂▄▅▃█▇▃▃▄▄▃▇▃▃▃▃▃▅▃▁ 25
graphql/graphql-spec 1.83 -1.05% ▃▂▃▄▇▇▃▄▄▆▅▂▄▂▂▅▅▂▇▃ 25
iluwatar/java-design-patterns 29.31 -0.66% ▃▂▅▂▆▄▄▄▆▂▂▄▃▄▆▂▆▅▂▃ 24
ktaranov/sqlserver-kit 22.80 -2.45% ▄▅▄▃▂▃▄▁█▃▆▃▂▃▄▁▄▅▆▁ 24
liriliri/licia 7.83 -3.24% ▄▅▄▄▄▅█▄▄▃▂▃▃▄▃▁▂▄▂▃ 24
MartinThoma/LaTeX-examples 13.30 -2.30% ▄▃▄▂▄▃▅▂▁▄▆▂▅▃▄▆▃ ▅▁ 24
mdx-js/mdx 3.73 -0.94% ▃▄▄▄▆▅▃▃▃▆▄▃▅▂▁▁▃█▃▃ 24
microsoft/TypeScript-Website 17.21 -2.44% ▃▂▆▆▃▄▂▃▄▃▃▂▄▄▂▁█▃▃▂ 24
MicrosoftDocs/PowerShell-Docs 110.97 5.25% ▃▃▃▂▄▄▃▃▃▃▄▄▇▄▃▃█▂▄▇ 25
neovim/nvim-lspconfig 8.98 6.76% ▅▃▁▁▄▅▄▅▄▁▆▂▄▅▇▃▃▄▂█ 24
pagekit/pagekit 7.26 -2.17% ▁▃▃▅▄█▄▄▅▃▅▅▃▃▃▁▃▆ ▂ 24
php/php-src 118.77 7.01% ▂▃▅▇▄▃▁▄▃▂▄▃▅▅▃▇▂▃▃█ 25
plasticrake/tplink-smarthome-api 1.47 -0.44% ▄▃▃▃▇▅▅▂▁▂▃▃▂▃▂▇▂▅▆▄ 24
prettier/prettier 13.13 0.56% ▂▂▄▄▃▃▃▂▂▆▅▃▆▃▃▂█▄▃▄ 24
pycontribs/jira 2.41 -0.66% ▃▃▃▃▆█▄▁▂▄▃▄▅▅▄▂▂▃▁▃ 24
RustPython/RustPython 13.71 3.28% ▄▃▅▁▇▆▂▄▃▁▂▆▂▄▃▄▆▂▃▆ 24
shoelace-style/shoelace 7.01 -3.89% ▄▅▅▃▃▃▃▅▄▂▅▃▃▄▁▃▄▁▄▂ 24
SoftwareBrothers/admin-bro 3.80 -5.22% ▄▃█▄▆▄▅▃▃▂▂▅▃▂▄▃▃▆▂▂ 24
sveltejs/svelte 34.50 -1.25% ▂▅▃▂█▆▄▃▆▅▂▁▃▂▃▄▆▄▃▃ 25
TheAlgorithms/Python 16.52 0.34% ▅▃▆▆█▄▄▄▂▃▃▃▃▂▅▅▂▄▃▄ 24
twbs/bootstrap 3.68 0.16% ▄▃▂▂▃▆▃▃▃▄█▆▂▄▂▄▄▄▂▄ 24
typescript-cheatsheets/react 2.06 -0.31% ▃▄▆▃▆█▁▆▃▅▃▃▂▂▃▂▃▅▂▄ 24
typescript-eslint/typescript-eslint 7.54 -3.76% ▄▄▅▇▄▆▃▅▂▂▅▁▅▅▄▂ ▆▂▂ 24
w3c/aria-practices 9.12 -5.17% ▃▂▇▃▅▃▂▄▃▅▃▃▃▆▂▆▄▂▂▁ 24
w3c/specberus 2.75 -2.62% ▂▄▃▃▇▅▄▂▄▄▅▃▂▃▂▂▃▃▂▂ 25
webdeveric/webpack-assets-manifest 0.70 -4.98% ▃▄▄▄██▃▃▄▃▄▃▃▄▄▃▃▂▄▂ 24
webpack/webpack 11.97 0.10% ▄▆▄▄▃▃▅▁▅▁▆▄▄▅ ▄▅▁▄▄ 24
wireapp/wire-desktop 1.26 2.69% ▃▃▃▄▆█▃█▃▂▃▄▃▃▂▃▄▅▄▅ 24
wireapp/wire-webapp 20.46 -3.09% ▃▅▃▃▆▃▃▄▂▂▃▃▃▄▃▂▃▃█▃ 25

Note:

  • Elapsed time is in seconds. The trend graph shows the last 10 runs.
    The SD graph shows the current run relative to the average and standard deviation.
  • Rel is the relative change from the average.

@Jason3S Jason3S marked this pull request as ready for review March 1, 2024 12:32
@Jason3S Jason3S merged commit d1888ea into main Mar 1, 2024
81 checks passed
@Jason3S Jason3S deleted the dev-files branch March 1, 2024 12:32
@Jason3S Jason3S changed the title feat: Add command-line options feat: Add --file [files...] command line option to lint command. Mar 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
feature
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

💡: Ignore files not specified in files but passed to the argument.
1 participant
@Jason3S